Azure Engagement System API - Implementation Template

Importing Templates into Anypoint Studio

1. In Studio, click the Exchange X icon in the upper left of the taskbar.
2. Log in with your Anypoint Platform credentials.
3. Search for the template.
4. Click Open.

Running Templates in Anypoint Studio

After you import your template into Studio, follow these configuration steps to run it.

Common Configuration

• mule.env - sets the environment where the application is to be deployed. It should be configured in config-<mule.env>.yaml file. For a studio deployment, the recommended mule.env value is local.
• mule.key - sets the encryption password to be used for encrypting secure properties. Update as needed.
• api.autoDiscoveryID should be configured in config-<mule.env>.yaml file.

Please refer to the attached link on how to secure the configuration properties.

HTTPS Configuration

• https.host — sets the service host interface. It should be configured in config-<mule.env>.yaml file. (Defaults to 0.0.0.0 for all interfaces).
• https.port — sets the HTTPS service port number. It should be configured in config-<mule.env>.yaml file. (Default 8082).
• https.defaultRecordLimit: Sets the default search limit for the result set. (Default 20).
• TLS Configuration - Keystore properties setup:
  • keystore.alias - sets the alias to the keystore. It should be configured in config-<mule.env>.yaml file.
  • keystore.path - sets the path to the key file. Key should be available in /src/main/resources/keystore. It should be configured in config-<mule.env>.yaml file.
  • keystore.keypass — sets keystore keypass to support HTTPS operation. It should be encrypted and configured in config-secured-<mule.env>.yaml file.
  • keystore.password— sets keystore password to support HTTPS operation. It should be encrypted and configured in config-secured-<mule.env>.yaml file.

Please refer to the attached link on how to generate the Keystore.

Azure Cosmos database Configuration

• azure-system.cosmos.host — sets the Azure Cosmos DB host. It should be configured in config-<mule.env>.yaml file.
• azure-system.cosmos.version — sets the Azure Cosmos DB API Version. It should be configured in config-<mule.env>.yaml file.
• azure-system.cosmos.web-engagement-db-id — sets the Azure Cosmos DB Id. It should be configured in config-<mule.env>.yaml file.
• azure-system.cosmos.web-engagement-coll-id — sets the Azure Cosmos DB collection Id. It should be configured in config-<mule.env>.yaml file.
• azure-system.cosmos.token — sets the Azure Cosmos DB access token. It should be encrypted and configured in config-secured-<mule.env>.yaml file.

Running it

1. Right-click the template project folder.
2. Hover your mouse over 'Run as'.
3. Click Mule Application (configure).
4. Inside the dialog, select Environment and set the variable mule.env to the appropriate value (e.g., dev or local).
5. Inside the dialog, select Environment and set the variable mule.encryptionKey to the property encryption key that you used to encrypt your secure properties.
6. Inside the dialog, go to 'Clear Application Data' select 'always' radio button.
7. Click Run.

Deployment instructions for CloudHub using provided scripts

Ensure the Maven profile CloudHub-DEV has been properly configured in your settings.xml file. Reference can be found by downloading the Accelerator Setup Guide asset. Additional instructions are available in Accelerator Setup Guide - Configuring the Accelerator Build section.

Update the config-<env>.yaml properties appropriately and then use one of the following scripts to deploy the application to CloudHub:

• packageDeploy.sh or deployOnly.sh (Mac/Linux)
• packageDeploy.cmd or deployOnly.cmd (Windows)

Test the template

• Use Advanced Rest Client or Postman to send a request over HTTPS. The template includes a Postman collection in the src/test/resources folder. Update the collection variable(s) after successful import.

Tested and verified

This solution was developed and tested on Anypoint Studio 7.14 and Mule Runtime 4.4.0.